home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 096 / proan51b.arc / PROANA.DOC next >
Encoding:
Text File  |  1987-07-07  |  24.6 KB  |  623 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.  
  12.                              Professional Analyzer
  13.                                   for RBBS-PC
  14.  
  15.                                  Version 15.1B
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.                      (C) Copyright 1987, RBBS-PC of Fargo
  59.              (C) Copyright 1984-1986, Lee Nelson and Jerry Sanders
  60.  
  61.  
  62.                                Table of Contents
  63.  
  64.  
  65.         Description of Product......................................   1
  66.  
  67.         Why Do You Need the Professional Analyzer?..................   1
  68.  
  69.         Starting Out................................................   1
  70.  
  71.         Bringing up ProAna..........................................   1
  72.  
  73.         The Main Menu...............................................   2
  74.  
  75.         Configuration...............................................   2
  76.  
  77.         Analyzing the Callers File..................................   3
  78.  
  79.         Making a Report.............................................   4
  80.  
  81.         Site Selected Statistics....................................   5
  82.  
  83.         Analyzing the Messages File.................................   6
  84.  
  85.         Analyzing the Users File....................................   6
  86.  
  87.         The PROSTATE.TBL File.......................................   7
  88.  
  89.         The User Editor.............................................   7
  90.  
  91.         You Found a Problem?........................................   8
  92.  
  93.         Limited Warranty............................................   8
  94.  
  95.         Distribution................................................   8
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.                                        i
  118.  
  119.  
  120.  
  121.  
  122.         Description of Product
  123.  
  124.           The  Professional  Analyzer  (ProAna)  is  a tool used to give
  125.         access to  important and  interesting statistics  when running a
  126.         bulletin board.  Information such  as when the most  people call
  127.         during the  day, how  many people  use the  ASCII protocol,  and
  128.         trivial things  such as  how many  people read  your bulletin on
  129.         Software Piracy are included in the reports.
  130.  
  131.         Why Do You Need the Professional Analyzer?
  132.  
  133.           Well, of course  if you don't  run a RBBS-PC  bulletin board I
  134.         can't  give  you  any  reasons,  but  if you do....  ProAna is a
  135.         productivity tool.  Let's say you run a BBS for your company and
  136.         you need to  know how many  out-of-state users you  have.  Well,
  137.         with ProAna you'd simply hit F4 at the main menu and,  surprise!
  138.         You would  receive a  complete breakdown  of how  many users you
  139.         have  from  each  state.   Or   if  you  are  a  SYSOP   who  is
  140.         contemplating  purchasing  a  2400  bps  modem,  and  you  have
  141.         borrowed one from a friend for a week and put it on-line.  After
  142.         that week, you can use the Callers File analyzer to see how many
  143.         people actually used the 2400 bps, and then make your  decision
  144.         based on that.  Another case would  be if you were a SYSOP  Beta
  145.         testing a new version of RBBS-PC that has some minor fixes  when
  146.         suddenly  RBBS  starts  trashing   every  user  who  answers   a
  147.         questionairre.  (Of course with  RBBS this would NEVER  happen!)
  148.         Luckily, you caught the bug after only one user got trashed, but
  149.         now that user's defaults are  all messed up.  Well, with  ProAna
  150.         you can edit almost every field and reset everything to  normal.
  151.         As you can see, the possibilities for ProAna are limitless!
  152.  
  153.         Starting Out
  154.  
  155.           ProAna is very easy  to install.  All you  have to do is  copy
  156.         all of your working files to ANY directory of your Hard Disk and
  157.         run it.  The  files required are  PROANA.EXE, the main  program,
  158.         PROCALL.EXE, the callers file analyzer, PROSTATE.TBL, the  table
  159.         that includes states and common abbreviations, and  PROCALL.CTL,
  160.         the file that includes special site-selected statistics.   (This
  161.         file is optional.)  If you would like to run ProAna from another
  162.         directory, say when you are  in "C:\RBBS" and you would  like to
  163.         run ProAna in "C:\RBBS\PROANA", you must use the SET environment
  164.         command to tell ProAna where to find it's files.  This could  be
  165.         accomplished by the following command:
  166.  
  167.                         Sat  06-30-87 13:51:44.05 C:\RBBS
  168.                         C>set PROANA=C:\RBBS\PROANA
  169.  
  170.         and then  you would  enter the command to start ProAna. But more
  171.         on that next!
  172.  
  173.         Bringing up ProAna
  174.  
  175.           To bring up ProAna you enter the command:
  176.  
  177.  
  178.                                        1
  179.  
  180.  
  181.  
  182.  
  183.  
  184.                         Sat  06-30-87 14:10:44.05 C:\RBBS
  185.                         C>proana #
  186.  
  187.         where '#' is the number of the node that you wish to analyze  or
  188.         edit. '#' must be a valid integer from 1 through 36.  If '#'  is
  189.         not included,  or is  invalid, ProAna  will assume  node #1  for
  190.         convenience.   Once you  have started  ProAna,  you  will see an
  191.         introductory screen that can be cleared by pressing any key.  If
  192.         this is the first time running ProAna on a particular node,  you
  193.         will not get the  introductory screen until you  have configured
  194.         ProAna.
  195.  
  196.         The Main Menu
  197.  
  198.           After you have brought up  ProAna, if you have run  it before,
  199.         you  will  be  given  a  Main  Menu to choose from.  The options
  200.         available are:
  201.  
  202.                         F1 - Configuration
  203.                         F2 - Analyze Callers file
  204.                         F3 - Analyze Messages file
  205.                         F4 - Analyze Users file
  206.                         F5 - Edit Users file
  207.                        ESC - Quit to DOS
  208.  
  209.           You can  select any  option by  pressing the  related function
  210.         key.  (E.g.  F1 will select the Configuration sub-program.)   If
  211.         you  HAVEN'T  run  ProAna  before,  you  will be given a message
  212.         saying that ProAna is  creating the necessary CONFIG  files, and
  213.         you will then be presented with a configuration screen, which is
  214.         described next.
  215.  
  216.         Configuration
  217.  
  218.           Before  you  can  use  ProAna,  you  must tell it some things.
  219.         First, you  need to  let it  know what  type of  monitor you are
  220.         using.  The default choice is "M" for monochrome, and if that is
  221.         correct, you should press the down arrow to continue.  (2 on the
  222.         numeric  keypad.)   If  you  are  using  a  color card and color
  223.         monitor, you should first change  that value to a "C",  and then
  224.         DO NOT  press the  down arrow.   ProAna will  advance you to the
  225.         next field automatically.
  226.  
  227.           After you have specified  your monitor type, you  must specify
  228.         the  name  of  your  RBBS  Callers  file  as specified in Config
  229.         parameter #85.  This may be any fully qualified path name up  to
  230.         26 characters long.
  231.  
  232.           Then after you enter the Callers file path and name, you  must
  233.         advance to the next field and enter the RBBS Messages file name.
  234.         This is  the same  file that  is described  in parameter  #81 of
  235.         Config.
  236.  
  237.  
  238.  
  239.                                        2
  240.  
  241.  
  242.  
  243.  
  244.           The next field is the name of RBBS's Users file.  This  should
  245.         be the same as the file specified in parameter #82 of Config.
  246.  
  247.           Following the Users file name, is the name of the ".DEF"  file
  248.         that  RBBS  uses.   This  will  be  "RBBSxPC.DEF"  where  'x' is
  249.         node-number  or  a  '-'  for  non-multiple  node  operations, by
  250.         default in RBBS.  Otherwise, if  you use a special name  for the
  251.         ".DEF" file, you must specify that.
  252.  
  253.           Next  is  the  name  of  the  file  that  ProCall  (the   call
  254.         analyzation program) uses when  you O)utput a report.   This can
  255.         be any name, including the name of the bulletin where the  SYSOP
  256.         keeps his  RBBS stats.   Following this,  are the  names of  the
  257.         dates between  which ProAna  will analyze  in the  Callers file.
  258.         These must  be numeric,  and the  default is  the whole file, by
  259.         specifying dates which are out of range.
  260.  
  261.           Finally, the  last field,  is the  name of  the file where the
  262.         User analysis exception report will be outputted.
  263.  
  264.           Once you are  finished, if everything  correct, hit the  {ESC}
  265.         key, and respond  "Y" to the  question "Save Configuration  File
  266.         <Y/N>?".
  267.  
  268.           As you can see when  the screen comes up, there  are defaults,
  269.         and if those suit  your particular configuration by  chance, you
  270.         may just press {ESC} and save it.
  271.  
  272.         Analyzing the CALLERS file
  273.  
  274.           One  of  the  most  important  functions  of  ProAna  is   the
  275.         analyzation of the callers file.  This provides a vast source of
  276.         information,  commonly  displayed  in  two  or more methods.  To
  277.         analyze the callers file, you must, from the Main Menu, push the
  278.         "F2" key which starts the seperate analyzation program.  It will
  279.         take a  little while  for it  to get  loaded, depending  on your
  280.         particular configuration.
  281.  
  282.           First, after having selected "F2" and ProCall (the name of the
  283.         call analyzation  program) having  been loaded,  you will  see a
  284.         display  similiar  to  this:
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.                                        3
  301.  
  302.  
  303.  
  304.  
  305.            +---------------------------------------------------------+
  306.            |  Buffer Size                   Date:       Time:        |
  307.            |   128                          06-30-1987  14:15:34     |
  308.            |  /                                       \/             |
  309.            | 1                                        2              |
  310.            |                                                         |
  311.            |                                                         |
  312.            |  Control Strings    Records    1st Logon  Last Logon    |
  313.            |               4      1858    5_ 06-27-87   06-30-87 _6  |
  314.            |             /       /1800     \ 12:48 PM   12:22 AM /   |
  315.            |            3       4     \                7             |
  316.            |                           8    Start Date/ \End Date    |
  317.            |                                01-01-1980   12-31-1999  |
  318.            +---------------------------------------------------------+
  319.  
  320.                         1) Buffer Size for CALLERS file
  321.                         2) Current Date & Time
  322.                         3) Number of strings in PROCALL.CTL file
  323.                         4) Number of records in CALLERS file
  324.                         5) Time & Date of 1st logon in CALLERS file
  325.                         6) Time & Date of last logon in CALLERS file
  326.                         7) Start & End date of range to analyze
  327.                         8) Number of records left to search in
  328.                            increments of 100.
  329.  
  330.         NOTE:  After ProCall is  finished  reading  the CALLERS file, it
  331.         will begin sorting.  A note will be displayed  in front of #8 to
  332.         that effect.
  333.  
  334.           Once  the  loading  process  is  finished,  ProCall  will then
  335.         display a menu of options that you may display.  First, you  can
  336.         return to this menu at  any time by pressing "F1".   Second, you
  337.         can  look  at  the  numbers  and  totals  for  all  the stats by
  338.         selecting "F2", or you can go right into it by pressing "+".
  339.  
  340.           There are  several pages  of these,  and to  navigate them you
  341.         must use the  "+" and "-"  keys.  On the  right while displaying
  342.         the stats, you will see a list of downloaded files, which can be
  343.         navigated by  using the  "PgDn" or  "3" on  the numeric  keypad,
  344.         "PgUp" or  "9" on  the numeric  keypad, "Home"  or "7", "End" or
  345.         "1", and can be sorted by count by pressing "s".
  346.  
  347.           After  the  stats  come  the  graphs.   The first graph can be
  348.         displayed by either pressing "F3"  or by paging past the  end of
  349.         the stats.  (You can page  through the whole report by  pressing
  350.         "+" and "-".)  This graph is a breakdown of the number of  calls
  351.         per hour.  This is one of the most important graphs, as it tells
  352.         when the bulletin board is being used the most.
  353.  
  354.           Next comes the graph of calls by "SPEED/BIT/CHANGE", which can
  355.         be  displayed  directly  by  the  "F4"  key.  This graph is also
  356.         important as it  shows how many  people are utilizing  each bps
  357.         rate from 300 up to 9600.  Also displayed is the number of calls
  358.         at  7-bit  and  the  number  of  calls at 8-bit, and lastly, the
  359.  
  360.  
  361.                                        4
  362.  
  363.  
  364.  
  365.  
  366.         number of changes from 300 to 450 bps, shown as "C450".
  367.  
  368.           Then comes two  graphs that are  tied together.  There  wasn't
  369.         enough room on  the first, so  it had to  be split up  into two.
  370.         The title isn't different, and to get to the second one you have
  371.         to page forward.  You can  access this one directly by  the "F5"
  372.         key.  These graphs show the number of uploads and downloads done
  373.         with each protocol, compared to the total.
  374.  
  375.           Finally, the last  two graphs are  graphs showing the  same as
  376.         the  above,  but  just  simplified  into  showing  one graph for
  377.         uploads and one for downloads.
  378.  
  379.         Outputting a Report
  380.  
  381.           Another excellent feature of ProCall is the ability to put all
  382.         these  statistics  into  an  easy-to-read, comprehensive report.
  383.         This  report  can  be  formatted  for  RBBS,  the screen, or for
  384.         printing.
  385.  
  386.           To output a report, you  must, after ProCall is loaded,  press
  387.         "o"  at  any  time  while  displaying  graphs, or the Main Menu.
  388.         (This is as shown on the  last couple lines of the display.   As
  389.         you've probably  discovered by  now, the  last few  lines of the
  390.         display usually have a brief summary of the options  available.)
  391.         After you select "o" you will be prompted for the type of format
  392.         you want  it outputted  for.  You  can select  "s" for "SCREEN",
  393.         which works well with text readers such as Vernon Buerg's "List"
  394.         program, or you can select "p" for "PRINTER", which will  format
  395.         it 66 lines/page, and adds extra things here and there.
  396.  
  397.           Finally, you  can select  "r" for  "RBBS" which  will output a
  398.         report based on  a screen length  of 23, and  usually works well
  399.         with RBBS.  It is rather  flaky, though, depending on where  you
  400.         start showing it, and this  is because of RBBS.  For  example if
  401.         you  selected  "N)ew  bulletins"  and  it  displayed  it  in the
  402.         context, the page  stops would be  different then selecting  "6"
  403.         from  the  bulletin  menu,  and  that  would  be  different then
  404.         selecting "b;6" from the main menu of RBBS.
  405.  
  406.           After you have  specified the format  for the report,  ProCall
  407.         will begin  writing the  report to  disk and  issue a message to
  408.         that effect.
  409.  
  410.           When you  are finished  with ProCall,  you can  press {ESC} to
  411.         return to the Main Menu of ProAna.
  412.  
  413.         Site Selected Satistics
  414.  
  415.           Occasionally, some SYSOPs will add their own messages that  go
  416.         into the CALLERS log.   Never fear, ProCall has  made provisions
  417.         for these special statistics!  An optional file you can have  in
  418.         your  ProAna  directory/disk,   is  a  file   by  the  name   of
  419.         "PROCALL.CTL", which contains control strings to search for, and
  420.  
  421.  
  422.                                        5
  423.  
  424.  
  425.  
  426.  
  427.         strings to be displayed on  the Site Selected Satistics page  of
  428.         ProCall's stats.  The format of this file is:
  429.  
  430.              "<SEARCH_STRING>","<DISPLAY_STRING>"
  431.  
  432.         where <SEARCH_STRING> is the string to search on in the  CALLERS
  433.         file, and <DISPLAY_STRING> is the string to be displayed on  the
  434.         screen.  You  can have  up to  19 site-selected  statistics, the
  435.         search string can be up to 20 characters long, and the displayed
  436.         string can be no longer than 25 characters long.  This file must
  437.         be created using  an ASCII editor,  and must contain  the double
  438.         quotation marks ('"') and the commas.  (',')
  439.  
  440.         Analyzing the Messages File
  441.  
  442.           The  MESSAGES  file  analyzation  routine  can  be  reached by
  443.         pressing "F3" from the Main Menu of ProAna.  It will take only a
  444.         few seconds  to load,  depending on  the size  of your  MESSAGES
  445.         file.
  446.  
  447.           This is one  of the easiest  routines to execute  in the whole
  448.         package, as there are no prompts, almost no waits, and only  one
  449.         screen.  So, the documentation for this one will be brief.   The
  450.         routine  will  display  various  information  concerning  RBBS's
  451.         MESSAGES  file,  including  how  many  nodes are sharing it, the
  452.         number of killed  messages, the number  of active messages,  the
  453.         number  of  kill  protected  messages,  the  number  of receiver
  454.         protected messages, the  number of password  protected messages,
  455.         the average number of records required by each message, and  the
  456.         list goes on and on.
  457.  
  458.           Some of the more confusing numbers are the  statistics on  the
  459.         right column of the  screen.  When ProAna says  "Record Number",
  460.         it means  "Record Number"!   The "Record  Number" is  the actual
  461.         record number where RBBS gets the certain statistic.
  462.  
  463.           To exit this subroutine, like the others, press {ESC} and  you
  464.         will be returned to ProAna's Main Menu.
  465.  
  466.         Analyzing the User File
  467.  
  468.           To analyze RBBS's  USERS file, press  "F4" from ProAna's  Main
  469.         Menu.   As  with  the  MESSAGES  file  analyzer, this routine is
  470.         fairly simple,  and takes  a few  seconds to  load.  After it is
  471.         loaded, the list of states  described later on will be  shown on
  472.         the display,  and ProAna  will start  analyzing the  USERS file.
  473.         The lower box on  the screen shows ProAna's  progress, including
  474.         the  number  of  users  found,  and  the number not found.
  475.  
  476.           Once completed, ProAna will ask  you if you want an  exception
  477.         list.  If you respond "y", you will be asked whether you want it
  478.         outputted to the screen, a file, or the printer.  If you specify
  479.         screen, ProAna will begin  listing the names and  city/states of
  480.         the users not found on  the screen.  If you choose  the printer,
  481.  
  482.  
  483.                                        6
  484.  
  485.  
  486.  
  487.  
  488.         the listing will be output on  the printer, and if you choose  a
  489.         file, ProAna will output the statistics to the file specified in
  490.         the ninth field of ProAna's configuration page.  Once  complete,
  491.         it  will  ask  if  you  want  another exception list, and if you
  492.         specify "y" for  yes, it will  allow you to  output it somewhere
  493.         else.
  494.  
  495.         The PROSTATE.TBL File
  496.  
  497.           Required by ProAna's user analyzation routine is a file called
  498.         "PROSTATE.TBL" which must exist  in the same drive/directory  as
  499.         ProAna.  This file  can have up  to 60 entries  in the following
  500.         format.
  501.  
  502.                 ST/LONG STATE NAME/CITY/CITY/CITY...etc.
  503.  
  504.         where   "ST"   is   the   2-character   abbreviation   for   the
  505.         state/country/providence, "LONG STATE NAME" is the full name  of
  506.         the state, and "CITY" is any number of cities in the state.  The
  507.         only required field  is "ST", which  is displayed on  the screen
  508.         and searched for.  The other fields are used to cut down on  the
  509.         number of exceptions because occasionally users specify a  city,
  510.         and no state,  or a long  name for a  state...etc.  These fields
  511.         all must be in CAPITAL LETTERS.
  512.  
  513.         The User Editor
  514.  
  515.           One of the most convenient  features of ProAna is the  ability
  516.         to edit almost all of the fields in the user record.  This would
  517.         be handy if,  for example, a  user moved.  The  SYSOP could then
  518.         start the user  editor by pressing "F5" from the Main Menu,  and
  519.         change the  user's city,  state, and  individuation (if needed).
  520.         The keys used in the User Editor are similiar to the keys in the
  521.         configuration editor, with the following exceptions.  "Home"  is
  522.         used mainly to verify the subscription dates on the second page,
  523.         but will also change the color (from green to cyan if on a color
  524.         display) of the  fields on the  second page.  "PgDn"  is used to
  525.         get to the  second page from  the first, and  "PgUp" is used  to
  526.         return to the first page.
  527.  
  528.           The only fields  that aren't editable  in the user  editor are
  529.         the "NAME" and "LAST DATE & TIME ON" fields.  ("LAST DATE & TIME
  530.         ON" will be editable in the next version.)
  531.  
  532.           You can change the fields to just about anything you want  to,
  533.         within the  realm of  reality.  For  example, you  can't set the
  534.         page length to  "hg" or the  subscription date to  "22-40-1943".
  535.         One note: The fields in bright white on a color display are  NOT
  536.         editable.
  537.  
  538.           The individuation  field is  the 19  bytes that  were formerly
  539.         used for "Machine Type" on older versions of RBBS-PC starting at
  540.         position 87 and extending to 105 in the user record.
  541.  
  542.  
  543.  
  544.                                        7
  545.  
  546.  
  547.  
  548.  
  549.         You Found a Problem?
  550.  
  551.           If something is not working as documented, or ProAna will  not
  552.         work in your  particular configuration, I'd  like to hear  about
  553.         it!  You can call me voice in the evenings between 6:00 pm,  and
  554.         9:00 pm CST, or call one  of the BBSs listed below and  leave me
  555.         mail.  I'm not guaranteeing anything, just saying that I'll  try
  556.         to do what I can.
  557.  
  558.         Limited Warranty
  559.  
  560.           These programs are provided  "as is", without any  warranty of
  561.         any  kind,  either  expressed  or  implied,  including,  but not
  562.         limited to the implied warranties of merchantability and fitness
  563.         for a particular purpose.  The entire risk as to the quality and
  564.         performance of  these programs  is with  you.  I  do not warrant
  565.         that the functions  contained in these  programs will suit  your
  566.         needs  or  that  the   operation  of  these  programs   will  be
  567.         uninteruppted or error free.
  568.  
  569.         Distribution
  570.  
  571.           Please  distribute  this  program  at  User  Groups,  and your
  572.         favorite bulletin boards.
  573.  
  574.           If you  use this  program, and  would like  more of it's kind,
  575.         please consider sending  a small contribution  of $20 to  one of
  576.         the following address.  The price of this program has been  kept
  577.         to such  a low  fee because  of the  understanding of  the time,
  578.         effort, and financial sacrifice that have gone into a BBS.
  579.  
  580.         Please send all contributions to:
  581.  
  582.                                         Professional Analyzer
  583.                                         P.O. Box 9121
  584.                                         Fargo, ND 58102
  585.  
  586.         There are many benefits involved if you contribute, including:
  587.  
  588.                         - A PRIVATE conference with the author on a
  589.                           bulletin board.
  590.  
  591.                         - A Limited 60 day subscription to RBBS-PC of
  592.                           Fargo's 4 node RBBS system with the above
  593.                           conference.
  594.  
  595.                         - Optionally, you can contribute via MC or VISA
  596.                           through IBM PCUG RBBS.
  597.  
  598.                         - You will receive notice of when the next
  599.                           version of ProAna is available.
  600.  
  601.         You can contact me on one of the following RBBS systems in ND:
  602.  
  603.  
  604.  
  605.                                        8
  606.  
  607.  
  608.  
  609.  
  610.         Satellite RBBS                  Fargo IBM PC Users Group BBS
  611.         (701) 293-3934                  (701) 293-5973   -   160 Meg
  612.         Andrew Hoag, Sysop              Loren D. Jones, Sysop
  613.         Voice: (701) 232-3811
  614.  
  615.           The latest version of ProAna will always be available on these
  616.         boards, and I will  try to keep the  latest on Jon Martin's  and
  617.         Tom Mack's.
  618.  
  619.                  Thank you for your support! Happy analyzing!
  620.  
  621.                                         Andrew J. Hoag - Author & Sysop
  622.  
  623.